<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="node414.html" />
<link rel="prev" href="node412.html" />
<link rel="parent" href="node409.html" />
<link rel="next" href="node414.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>14.5.5.4 TimedRotatingFileHandler</title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="14.5.5.3 RotatingFileHandler"
  href="node412.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="14.5.5 handler Objects"
  href="node409.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="14.5.5.5 SocketHandler"
  href="node414.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node412.html">14.5.5.3 RotatingFileHandler</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="node409.html">14.5.5 Handler Objects</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node414.html">14.5.5.5 SocketHandler</a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h3><a name="SECTION0016554000000000000000">
14.5.5.4 TimedRotatingFileHandler</a>
</h3>

<p>
The <tt class="class">TimedRotatingFileHandler</tt> class, located in the
<tt class="module">logging.handlers</tt> module, supports rotation of disk log files
at certain timed intervals.

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-2916' xml:id='l2h-2916' class="class">TimedRotatingFileHandler</tt></b>(</nobr></td>
  <td><var>filename
                                            </var><big>[</big><var>,when
                                            </var><big>[</big><var>,interval
                                            </var><big>[</big><var>,backupCount</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>

<p>
Returns a new instance of the <tt class="class">TimedRotatingFileHandler</tt> class. The
specified file is opened and used as the stream for logging. On rotating
it also sets the filename suffix. Rotating happens based on the product
of <var>when</var> and <var>interval</var>.

<p>
You can use the <var>when</var> to specify the type of <var>interval</var>. The
list of possible values is, note that they are not case sensitive:

<p>
<div class="center"><table class="realtable">
  <thead>
    <tr>
      <th class="left"  >Value</th>
      <th class="left"  >Type of interval</th>
      </tr>
    </thead>
  <tbody>
    <tr><td class="left"   valign="baseline">S</td>
        <td class="left"  >Seconds</td></tr>
    <tr><td class="left"   valign="baseline">M</td>
        <td class="left"  >Minutes</td></tr>
    <tr><td class="left"   valign="baseline">H</td>
        <td class="left"  >Hours</td></tr>
    <tr><td class="left"   valign="baseline">D</td>
        <td class="left"  >Days</td></tr>
    <tr><td class="left"   valign="baseline">W</td>
        <td class="left"  >Week day (0=Monday)</td></tr>
    <tr><td class="left"   valign="baseline">midnight</td>
        <td class="left"  >Roll over at midnight</td></tr></tbody>
</table></div>

<p>
If <var>backupCount</var> is non-zero, the system will save old log files by
appending extensions to the filename. The extensions are date-and-time
based, using the strftime format <code>%Y-%m-%d_%H-%M-%S</code> or a leading
portion thereof, depending on the rollover interval. At most <var>backupCount</var>
files will be kept, and if more would be created when rollover occurs, the
oldest one is deleted.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2917' xml:id='l2h-2917' class="method">doRollover</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Does a rollover, as described above.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2918' xml:id='l2h-2918' class="method">emit</tt></b>(</nobr></td>
  <td><var>record</var>)</td></tr></table></dt>
<dd>
Outputs the record to the file, catering for rollover as described
above.
</dl>

<p>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="14.5.5.3 RotatingFileHandler"
  href="node412.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="14.5.5 handler Objects"
  href="node409.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="14.5.5.5 SocketHandler"
  href="node414.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node412.html">14.5.5.3 RotatingFileHandler</a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="node409.html">14.5.5 Handler Objects</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node414.html">14.5.5.5 SocketHandler</a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
